<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="IE=edge,chrome=1" charset="utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>BE.proj</title>
        <link rel="stylesheet" href="../css/default.css" type="text/css" media="screen, projection">
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Array.html">Array</a></li>
	
	<li><a href="../symbols/BE.html">BE</a></li>
	
	<li><a href="../symbols/BE.comp.html">BE.comp</a></li>
	
	<li><a href="../symbols/BE.ERROR.html">BE.ERROR</a></li>
	
	<li><a href="../symbols/BE.layer.html">BE.layer</a></li>
	
	<li><a href="../symbols/BE.log.html">BE.log</a></li>
	
	<li><a href="../symbols/BE.proj.html">BE.proj</a></li>
	
	<li><a href="../symbols/BE.time.html">BE.time</a></li>
	
	<li><a href="../symbols/BE.ui.html">BE.ui</a></li>
	
	<li><a href="../symbols/BE.ui.viewsConstructor.html">BE.ui.viewsConstructor</a></li>
	
	<li><a href="../symbols/BE.util.SettingsManager.html">BE.util.SettingsManager</a></li>
	
	<li><a href="../symbols/String.html">String</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace BE.proj
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				<br />Extends
					<a href="../symbols/BE.html">BE</a>.<br />
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_collinbrooks_Dropbox_Scripts_AEScripts_BeforeEffects_src_proj_proj.jsxinc.html">proj.jsxinc</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class BE.proj.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/BE.proj.html#constructor">BE.proj</a></b>
							</div>
							<div class="description">Contains project helper methods that provide more functionality than the
original AE API.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class BE.proj.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								BE.proj.<b><a href="../symbols/BE.proj.html#.compositionCache">compositionCache</a></b>
								</div>
								<div class="description">The list of compositions that have been found within the project.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								BE.proj.<b><a href="../symbols/BE.proj.html#.footageCache">footageCache</a></b>
								</div>
								<div class="description">The list of footage items that have been found within the project.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								BE.proj.<b><a href="../symbols/BE.proj.html#.itemCache">itemCache</a></b>
								</div>
								<div class="description">An array of items collected by the getItemList method and that have been
found within the project.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				
				</dl>
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class BE.proj.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.compExists">compExists</a></b>(n, c)
								</div>
								<div class="description">Returns whether or not a composition with the given name exists.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getActiveComp">getActiveComp</a></b>()
								</div>
								<div class="description">Get the project's active composition.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getActiveItem">getActiveItem</a></b>()
								</div>
								<div class="description">Get the project's active item.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getCompByName">getCompByName</a></b>(n, f)
								</div>
								<div class="description">Grab the first composition found in the project's items
with the given name at an optionalnly given root folder.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getCompList">getCompList</a></b>(c)
								</div>
								<div class="description">Gathers an array of compositions that are within the project.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getFolderByName">getFolderByName</a></b>(n, f)
								</div>
								<div class="description">Grab the first folder found in the project's items
with the given name.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getFootageList">getFootageList</a></b>(c)
								</div>
								<div class="description">Gathers an array of footage items that are within the project.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getItemById">getItemById</a></b>(id)
								</div>
								<div class="description">Get the Item object that has the given identifier id.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getItemByName">getItemByName</a></b>(n, f)
								</div>
								<div class="description">Grab the first project item found with the given name.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getItemList">getItemList</a></b>(items, c)
								</div>
								<div class="description">Get an optionally filtered list of the items within the active project.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.getProject">getProject</a></b>()
								</div>
								<div class="description">Grab the current active project if there is one.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.itemExists">itemExists</a></b>(n, c, d)
								</div>
								<div class="description">Returns whether or not there is an item with the given name within the
project's items.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.trimItemName">trimItemName</a></b>(theItems)
								</div>
								<div class="description">Removes whitespace at the start and end of the name(s) of the
provided item(s).</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.proj.<b><a href="../symbols/BE.proj.html#.verifyProjAndActiveItem">verifyProjAndActiveItem</a></b>()
								</div>
								<div class="description">Convenience function that makes sure a project and/or an activeItem are
defined.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				
				</dl>
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>BE.proj</b>
				</div>
				
				<div class="description">
					Contains project helper methods that provide more functionality than the
original AE API.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">See:</dt>
						
							<dd><a href="../symbols/BE.html">BE</a></dd>
						
						</dl>
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name=".compositionCache"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.proj.</span><b>compositionCache</b>
					
					</div>
					<div class="description">
						The list of compositions that have been found within the project.
By caching the list of the project's compositions, we can more quickly
act upon this data without having to traverse the project's items. You
should only use this when you know that there is no way a composition
could have been added.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name=".footageCache"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.proj.</span><b>footageCache</b>
					
					</div>
					<div class="description">
						The list of footage items that have been found within the project.
By caching the list of the project's footage items, we can more quickly
act upon this data without having to traverse the project's items. You
should only use this when you know that there is no way a footage item
could have been added.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name=".itemCache"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.proj.</span><b>itemCache</b>
					
					</div>
					<div class="description">
						An array of items collected by the getItemList method and that have been
found within the project.
By caching the list of the items returned, we can more quickly
act upon this data without having to traverse the project's items. You
should only use this when you know what is in the cache and that
there is no way a any items could have been added.
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".compExists"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Bool|null}</span>
					<span class="light">BE.proj.</span><b>compExists</b>(n, c)
					
					</div>
					<div class="description">
						Returns whether or not a composition with the given name exists.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>n</b>
									
								</dt>
								<dd>The name of the composition to search for</dd>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>c</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd>Whether or not to use the compositionCache value. Useful
when you have recently traversed the project to find all of the
composition items and you know none have been added since then.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Bool|null}</span> True if the composition exists, false if it doesn't.
null if there is not a project defined.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getActiveComp"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Bool|Item}</span>
					<span class="light">BE.proj.</span><b>getActiveComp</b>()
					
					</div>
					<div class="description">
						Get the project's active composition.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Bool|Item}</span> False if there is no active item or the currently
active item within the project is not a CompItem.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getActiveItem"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Bool|Item}</span>
					<span class="light">BE.proj.</span><b>getActiveItem</b>()
					
					</div>
					<div class="description">
						Get the project's active item. This could be a CompItem, AVItem,
FolderItem, etc. Use getActiveComp to get the active composition.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Bool|Item}</span> False if there is no active item or the currently
active item within the project.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getCompByName"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{CompItem|null}</span>
					<span class="light">BE.proj.</span><b>getCompByName</b>(n, f)
					
					</div>
					<div class="description">
						Grab the first composition found in the project's items
with the given name at an optionalnly given root folder.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>n</b>
									
								</dt>
								<dd>The name of the composition to find.</dd>
							
								<dt>
									<span class="light fixedFont">{Folder}</span> <b>f</b>
									<i>Optional</i>
								</dt>
								<dd>The folder to use as the root of the search. This is
helpful if you know you don't need to search through the entire project but
only a specific folder for one.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{CompItem|null}</span> Returns the first composition that is found
within the project with the given name or null if none is found.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getCompList"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{CompItem[]|Bool}</span>
					<span class="light">BE.proj.</span><b>getCompList</b>(c)
					
					</div>
					<div class="description">
						Gathers an array of compositions that are within the project.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>c</b>
									
								</dt>
								<dd>Whether or not to use the cached array of the project's
compositions. This is useful when you are calling this method back to
back and you don't need to grab the current list of compositions.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{CompItem[]|Bool}</span> If there were no errors, an array of
compositions is returned. Otherwise, false is returned.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getFolderByName"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{FolderItem|null}</span>
					<span class="light">BE.proj.</span><b>getFolderByName</b>(n, f)
					
					</div>
					<div class="description">
						Grab the first folder found in the project's items
with the given name.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>n</b>
									
								</dt>
								<dd>The name of the folder to find.</dd>
							
								<dt>
									<span class="light fixedFont">{Folder}</span> <b>f</b>
									<i>Optional</i>
								</dt>
								<dd>The folder to use as the root of the search. This is
helpful if you know you don't need to search through the entire project but
only a specific folder for one.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{FolderItem|null}</span> Returns the first folder that is found
within the project with the given name or null if none is found.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getFootageList"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{AVItem[]|Bool}</span>
					<span class="light">BE.proj.</span><b>getFootageList</b>(c)
					
					</div>
					<div class="description">
						Gathers an array of footage items that are within the project.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>c</b>
									
								</dt>
								<dd>Whether or not to use the cached array of the project's
footage items. This is useful when you are calling this method back to
back and you don't need to grab the current list of footage items.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{AVItem[]|Bool}</span> If there were no errors, an array of footage
items is returned. Otherwise, false is returned.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getItemById"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Item|Bool}</span>
					<span class="light">BE.proj.</span><b>getItemById</b>(id)
					
					</div>
					<div class="description">
						Get the Item object that has the given identifier id.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Int}</span> <b>id</b>
									
								</dt>
								<dd>The unique identifier id of the item within the project.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Item|Bool}</span> Returns the Item that has the given id or false if
the checks within the getItemList or getProject methods fail.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getItemByName"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Item|null}</span>
					<span class="light">BE.proj.</span><b>getItemByName</b>(n, f)
					
					</div>
					<div class="description">
						Grab the first project item found with the given name.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>n</b>
									
								</dt>
								<dd>The name of the item to find.</dd>
							
								<dt>
									<span class="light fixedFont">{Folder}</span> <b>f</b>
									<i>Optional</i>
								</dt>
								<dd>The folder to use as the root of the search. This is
helpful if you know you don't need to search through the entire project but
only a specific folder for one.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Item|null}</span> Returns the first project item that is found
within the project with the given name or null if none is found.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getItemList"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
					<span class="light">BE.proj.</span><b>getItemList</b>(items, c)
					
					</div>
					<div class="description">
						Get an optionally filtered list of the items within the active project.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>|<a href="../symbols/Array.html">Array</a>}</span> <b>items</b>
									<i>Optional</i>
								</dt>
								<dd>The typeName (or an array of typeNames)of
the Item to include in the returned values.

Example: "Composition", "Folder", "Footage"</dd>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>c</b>
									
								</dt>
								<dd>Whether or not to utilize the cached items that were found
when this method was previously executed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> A 0 based array of the filtered items.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getProject"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Bool|ProjectItem}</span>
					<span class="light">BE.proj.</span><b>getProject</b>()
					
					</div>
					<div class="description">
						Grab the current active project if there is one.

NOTE: Make sure to check whether or not this method returns false.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Bool|ProjectItem}</span> False if the project is not defined or
the ProjectItem that is currently active.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".itemExists"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Bool|null}</span>
					<span class="light">BE.proj.</span><b>itemExists</b>(n, c, d)
					
					</div>
					<div class="description">
						Returns whether or not there is an item with the given name within the
project's items.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>n</b>
									
								</dt>
								<dd>The name of the composition to search for</dd>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>c</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd>Whether or not to use the compositionCache value.
Useful when you have recently traversed the project to find all of the
composition items and you know none have been added since then.</dd>
							
								<dt>
									<span class="light fixedFont">{Bool}</span> <b>d</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd>True to make sure the given name is only found
once. False to ignore whether or not there are multiple Items with the
given name.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Throws:</dt>
							
								<dt>
									 <b></b>
								</dt>
								<dd>UndefinedProject if a project cannot be defined.

TODO:
-Implement the cache system</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Bool|null}</span> True if the composition exists, false if it doesn't.
null if there is not a project defined.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".trimItemName"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Project}</span>
					<span class="light">BE.proj.</span><b>trimItemName</b>(theItems)
					
					</div>
					<div class="description">
						Removes whitespace at the start and end of the name(s) of the
provided item(s).
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Items[]}</span> <b>theItems</b>
									
								</dt>
								<dd>An array of project Items whose name should be trimmed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Project}</span> The current project. Useful for chainging.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".verifyProjAndActiveItem"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Bool|<a href="../symbols/Array.html">Array</a>}</span>
					<span class="light">BE.proj.</span><b>verifyProjAndActiveItem</b>()
					
					</div>
					<div class="description">
						Convenience function that makes sure a project and/or an activeItem are
defined. If both are undefined, false is returned. If one or the other
is undefined, false is returned as the value within the returned array.
						
						
					</div>
					
					
					
					<pre class="code">if (v = BE.proj.verifyProjAndActiveItem()) {
 proj = v[0];
 comp = v[1];
}</pre>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Bool|<a href="../symbols/Array.html">Array</a>}</span> A zero based array containing a reference to the
project object and activeItem respectively or False if proj and activeItem
are undefined.</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy;2010<br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sun May 22 2011 22:54:53 GMT-0500 (CDT)
		</div>
	</body>
</html>
